XIQS Rack List

From IQsimWiki

Jump to: navigation, search

XIQS Rack List - Sim Rack Management

Description
getXIQSRackList ( [ Long id_partition ] [, SimpleFilterObject SimpleFilter ] )

Get a list of IRON Sim Rack objects owned by this user's partition. In the case the current logged user is
dministrator, he gets the full list of all available IRON Sim Racks objects unless a 'partition id' parameter is
pecified.

Parameters

[ Long id_partition ] Partition Id [ SimpleFilterObject SimpleFilter ]

Return Values
List <Rack Object>
Integer id - Rack ID

String name - Rack Name

String ip - Primary IP address of the given Rack

Long tcpport - Rack port.The port is 51503 by default. If two iQSIM Arrays have the same public IP address, they will then need to be addressed using different ports.

Integer status - Rack status (0 - unavailable, 1 - working)

String slotport - Number of SIM ports per Slot (ex. "0,0,10,6,32")

Integer slotnb - Number of Slots

Integer slotmode - Slot mode

Integer cardnb - Number of SIM cards

Long id_manager - Sim Server Id

String managername - Sim Server Name

Long id_partition - Partition Id

String ip2 - Secondary IP address of the given Rack

Long tcpport2 - Rack port2. If two iQSIM Arrays have the same public IP address, they will then need to be addressed using different ports.

String dns - Rack DNS

String dns2 - Rack DNS2

String ftpdns - FTP dns address

Integer ftpport - FTP port

String ftplogin - FTP user login

String ftppassw - FTP user password

String version - SimRack software version

Error Data structure ( Error Management )

Possible failure code returns
*ERR_SRV_INTERNAL (500) ERR_MSG_NO_DB
See Also

createXIQSRack
updateXIQSRack
deleteXIQSRack

Example

[REQUEST]

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<command tid="4d5541d2-e9f1-498c-a7a9-8587ca132cb8" name="getXIQSRackList">

  <param type="long">2</param>

  <simplefilter>

    <start>0</start>

    <limit>25</limit>

    <DIR>DESC</DIR>

    <SORT>id</SORT>

  </simplefilter>

</command>

[ANSWER (OK)]

<?xml version="1.0" encoding="ISO-8859-1"?>

<event type="return" tid="4d5541d2-e9f1-498c-a7a9-8587ca132cb8">

  <meta-data>

    <meta-value>

      <name>start</name>

      <pos>1</pos>

    </meta-value>

    <meta-value>

      <name>count</name>

      <pos>2</pos>

    </meta-value>

    <meta-value>

      <name>total</name>

      <pos>3</pos>

    </meta-value>

    <rack-meta>

      <meta-value>

        <name>id</name>

        <pos>1</pos>

      </meta-value>

      <meta-value>

        <name>name</name>

        <pos>2</pos>

      </meta-value>

      <meta-value>

        <name>ip</name>

        <pos>3</pos>

      </meta-value>

      <meta-value>

        <name>tcpport</name>

        <pos>4</pos>

      </meta-value>

      <meta-value>

        <name>status</name>

        <pos>5</pos>

      </meta-value>

      <meta-value>

        <name>slotport</name>

        <pos>6</pos>

      </meta-value>

      <meta-value>

        <name>slotnb</name>

        <pos>7</pos>

      </meta-value>

      <meta-value>

        <name>slotmode</name>

        <pos>8</pos>

      </meta-value>

      <meta-value>

        <name>cardnb</name>

        <pos>9</pos>

      </meta-value>

      <meta-value>

        <name>id_manager</name>

        <pos>10</pos>

      </meta-value>

      <meta-value>

        <name>managername</name>

        <pos>11</pos>

      </meta-value>

      <meta-value>

        <name>id_partition</name>

        <pos>12</pos>

      </meta-value>

      <meta-value>

        <name>ip2</name>

        <pos>13</pos>

      </meta-value>

      <meta-value>

        <name>tcpport2</name>

        <pos>14</pos>

      </meta-value>

      <meta-value>

        <name>dns</name>

        <pos>15</pos>

      </meta-value>

      <meta-value>

        <name>dns2</name>

        <pos>16</pos>

      </meta-value>

    </rack-meta>

  </meta-data>

  <param type="long">0</param>

  <param type="long">25</param>

  <param type="long">1</param>

  <rack>

    <param type="long">1</param>

    <param type="string">SimRack1</param>

    <param type="string">217.108.104.100</param>

    <param type="long">51503</param>

    <param type="integer">1</param>

    <param type="string">0,32,32,0,32,32,32,0,0,0,0,0,0</param>

    <param type="integer">13</param>

    <param type="integer">0</param>

    <param type="integer">160</param>

    <param type="long">1</param>

    <param type="string">smartironv2</param>

    <param type="long">2</param>

    <param type="string"></param>

    <param type="long">0</param>

    <param type="string">217.108.104.100</param>

    <param type="string"></param>

  </rack>

</event>

[ANSWER (Error)]

<?xml version="1.0" encoding="ISO-8859-1"?>

<event type="error">

  <meta-data>

    <meta-value>

      <name>err_code</name>

      <pos>1</pos>

    </meta-value>

    <meta-value>

      <name>err_desc</name>

      <pos>2</pos>

    </meta-value>

  </meta-data>

  <param type="integer">500</param>

  <param type="string"> err.db.connection.failed</param>

</event>

Personal tools
Namespaces
Variants
Views
Actions
Navigation
XIQS XML Protocol
XIQS Framework Libraries
XIQS Command List